home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / clipper / rpcxlb10.zip / RPCXLIB.DOC < prev    next >
Text File  |  1993-08-12  |  28KB  |  787 lines
  1. .-------------------------------------------------------------------------.
  2. |                                                                         |
  3. |                       RPCXLib  version 1.0 (11/08/93)                   |
  4. |                                                                         |
  5. |                                                                         |
  6. |                    (c) 1993  Rolf van Gelder, EINDHOVEN                 |
  7. |                                                                         |
  8. |_________________________________________________________________________|
  9.  
  10. 1     INTRODUCTION --------------------------------------------------------
  11.  
  12.  
  13.       RPCXLib is a CLIPPER LIBRARY with GRAPHIC FUNCTIONS.
  14.  
  15.       Because RPCXLib is fully written in ASSEMBLER its functions are
  16.       VERY FAST !
  17.       Therefore the library is also INDEPENDENT of the Clipper version and
  18.       can be used in combination with Clipper Summer'87, Clipper 5.0,
  19.       Clipper 5.01, Clipper 5.2x, etc.
  20.  
  21.       RPCXLib is the successor of the shareware function R_ShowPCX(),
  22.       a function to show PCX-files on the screen.
  23.  
  24.       This function has been CONSIDERABLY IMPROVED and EXTENDED and is
  25.       included in the new RPCXLib library. 
  26.  
  27.       RPCXLib is a Shareware product :
  28.  
  29.       You have the opportunity to try the program at no charge to see if
  30.       it meets your needs.
  31.       If you continue to use the program after evaluation,
  32.       please complete the included registration form (RPCXLib.FRM)
  33.       and send it with the applicable registration fee to the author.
  34.  
  35.  
  36.       FEATURES :
  37.  
  38.  
  39.       *    RShowPCX function to display a PCX graphic file :
  40.  
  41.            -     very FAST !
  42.  
  43.            -     of UNLIMITED SIZE
  44.  
  45.            -     on a SPECIFIC screen location
  46.  
  47.            -     on EGA/VGA and SUPERVGA screens
  48.  
  49.            -     up to a resolution of 640 x 480 x 256 (SUPERVGA)
  50.  
  51.            -     with AUTOMATIC DETECTION and USE of almost all
  52.                  SUPERVGA adapters
  53.  
  54.            -     with support of the INTERNATIONAL VESA STANDARD
  55.  
  56.       *    Functions to mix ones own CLIPPER COLOURS
  57.            YOU CAN COMPOSE 262.144 DIFFERENT COLOURS !
  58.  
  59.       *    Functions to slowly DIM the screen
  60.  
  61.       *    Functions to determine the GRAPHIC CONFIGURATION of a PC :
  62.            Is there a EGA, VGA, MCGA or SUPERVGA adapter available ?
  63.            When there is a SUPERVGA adapter available you can, in most
  64.            cases, determine the brand
  65.  
  66.        *   A NORTON GUIDE with a description of all functions in the library
  67.  
  68.  
  69.  
  70. 2     GRAPHIC ADAPTERS AND VIDEO MODES ------------------------------------
  71.  
  72.  
  73.       The minimum requirements for using RPCXLib is a PC with an EGA card;
  74.       CGA and Hercules adapters are not supported.
  75.  
  76.       To show PCX-files (using the function R_ShowPCX()) you can use
  77.       EGA, VGA and SuperVGA adapters.
  78.  
  79.       EGA :
  80.       When you have an EGA adapter you are able to show 16 colour PCX-files
  81.       up to a dimension of 640 x 350 pixels.
  82.       (Maximum resolution: 640 x 350 x 16)
  83.  
  84.       VGA :
  85.       When you have a STANDARD VGA adapter you are able to show 16 colour
  86.       PCX-files up to a dimension of 640 x 480 and 256 colour files up to
  87.       a dimension of 320 x 200 pixels.
  88.       (Maximum resolution: 640 x 480 x 16 or 320 x 200 x 256)
  89.  
  90.       SuperVGA :
  91.       When you have a SUPERVGA adapter (which is supported by RPCXLib)
  92.       you are able to show 256 colours PCX-files up to a dimension of
  93.       640 x 480 pixels. Provided that the used adapter supports the
  94.       640 x 480 x 256 video mode.
  95.       (Maximum resolution: 640 x 480 x 256)
  96.  
  97.       RPCXLib detects and uses the following SuperVGA adapters :
  98.  
  99.       -    Ahead Systems, type A & B
  100.       -    ATI Wonder Card
  101.       -    Chips & Technologies
  102.       -    Everex VGA
  103.       -    Genoa GVGA
  104.       -    NCR 77C22
  105.       -    Oak Technologies OTI-67
  106.       -    Paradise VGA
  107.       -    Trident 8800
  108.       -    Trident 8900
  109.       -    Tseng Labs ET3000
  110.       -    Tseng Labs ET4000
  111.       -    VESA BIOS Extensions
  112.       -    Video 7
  113.  
  114.       When your adapter is NOT listed above you probably still can use
  115.       the SuperVGA features of RPCXLib.
  116.       This can be done using the VESA BIOS EXTENSIONS driver.
  117.  
  118.       VESA (Video Electronics Standards Association) is a standardization
  119.       in the field of graphic adapters.
  120.       For almost any SuperVGA card there is a little (TSR) program that
  121.       emulates the VESA standard. By using this program, RPCXLib will
  122.       work together with your (not listed) SuperVGA adapter.
  123.       The VESA emulation programs mentioned above are often included in
  124.       the software package that comes with the SuperVGA card.
  125.       When this is not the case you can probably find the program in the
  126.       Public Domain / Shareware circuit.
  127.  
  128.  
  129.  
  130. 3     EGA/VGA COLOUR PALETTES ----------------------------------------------
  131.  
  132.  
  133.       In RPCXLib the are some functions to change the colour palette of your
  134.       EGA/VGA adapter. You can use these functions to compose your own
  135.       Clipper colour palette.
  136.  
  137.       Clipper uses 16 pre-defined colours. Each Clipper colour is paired with
  138.       a so-called colour register. A colour register contains the "composition"
  139.       of a specific colour. This composition consists of a RED, GREEN and BLUE
  140.       component (values ranging from 0 to 63).
  141.       Some examples (values actually used by Clipper) :
  142.  
  143.                        ------- Components  -------
  144.                        RED        GREEN       BLUE
  145.  
  146.       BLACK            0          0           0
  147.       BRIGHT WHITE     63         63          63
  148.       NORMAL WHITE     42         42          42
  149.       GREY             21         21          21
  150.       BRIGHT RED       63         0           0
  151.       RED              42         0           0
  152.       GREEN            0          42          0
  153.       BLUE             0          0           42
  154.       MAGENTA          42         0           42
  155.  
  156.       The composition of the Clipper colours can be found in the header
  157.       file (RPCXLib.CH).
  158.  
  159.       Clipper DOESN'T use register numbers 0-15 but :
  160.  
  161.       Registers #  0 -  7   : normal colours
  162.       Registers # 56 - 63   : bright colours
  163.  
  164.       All Clipper colours and matching register numbers are listed in
  165.       the header file RPCXLib.CH.
  166.  
  167.       Example :
  168.       To determine the register number of the Clipper colour MAGENTA you
  169.       can use the pre-defined PL_MAGENTA constant that substitutes the
  170.       correct register number.
  171.  
  172.       The use of the palette functions is described in the next chapter.
  173.  
  174.  
  175.  
  176. 4     FUNCTIONS IN RPCXLIB ------------------------------------------------
  177.  
  178. 4.1   Function R_DefPal : Installs the default Clipper colour palette
  179.  
  180.       Syntax
  181.            R_DefPal ()
  182.  
  183.       Parameters
  184.            (None)
  185.  
  186.       Returns
  187.            NIL
  188.  
  189.       Description
  190.            By calling the R_DefPal () function the 16 Clipper colours are
  191.            initialized to their default values. This function is for example
  192.            useful at the end of an application : it makes sure that the
  193.            the colour palette is reset to its original state (after possible
  194.            changes you made to the palette).
  195.  
  196.       Example
  197.            See the demo program PCXDemo.PRG
  198.  
  199.  
  200. 4.2   Function R_GetRGB : Determines the composition of a specific colour
  201.  
  202.       Syntax
  203.            R_GetRGB ( nRegNr, @nRed, @nGreen, @nBlue )
  204.  
  205.       Parameters
  206.            nRegNr      Number of the colour register of which the composition
  207.                        has to be determined
  208.                        (range : 0-63)
  209.  
  210.            @nRed       Variable (BY REFERENCE !) to which the RED component
  211.                        is returned
  212.                        (range : 0-63)
  213.  
  214.            @nGreen     Variable (BY REFERENCE !) to which the GREEN component
  215.                        is returned
  216.                        (range : 0-63)
  217.  
  218.            @nBlue      Variable (BY REFERENCE !) to which the BLUE component
  219.                        is returned
  220.